SpringParams

Physical parameters of a spring for [class@SpringAnimation].

Any spring can be described by three parameters: mass, stiffness and damping.

An undamped spring will produce an oscillatory motion which will go on forever.

The frequency and amplitude of the oscillations will be determined by the stiffness (how "strong" the spring is) and its mass (how much "inertia" it has).

If damping is larger than 0, the amplitude of that oscillating motion will exponientally decrease over time. If that damping is strong enough that the spring can't complete a full oscillation, it's called an overdamped spring.

If we the spring can oscillate, it's called an underdamped spring.

The value between these two behaviors is called critical damping; a critically damped spring will comes to rest in the minimum possible time without producing oscillations.

The damping can be replaced by damping ratio, which produces the following springs:

* 0: an undamped spring. * Between 0 and 1: an underdamped spring. * 1: a critically damped spring. * Larger than 1: an overdamped spring.

As such

class SpringParams {

protected

AdwSpringParams* adwSpringParams;

protected

bool ownedRef;

AdwSpringParams* getSpringParamsStruct(bool transferOwnership);

void* getStruct();

this(AdwSpringParams* adwSpringParams, bool ownedRef);

~this();

static GType getType();

this(double dampingRatio, double mass, double stiffness);

double getDamping();

double getDampingRatio();

double getMass();

double getStiffness();

alias doref = ref_;

SpringParams ref_();

void unref();

}

Constructors

this this(AdwSpringParams* adwSpringParams, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(double dampingRatio, double mass, double stiffness): Creates a new AdwSpringParams from @mass, @stiffness and @damping_ratio.

Destructor

~this ~this(): Undocumented in source.

Members

Aliases

doref alias doref = ref_: Undocumented in source.

Functions

getDamping double getDamping(): Gets the damping of @self.
getDampingRatio double getDampingRatio(): Gets the damping ratio of @self.
getMass double getMass(): Gets the mass of @self.
getSpringParamsStruct AdwSpringParams* getSpringParamsStruct(bool transferOwnership): Get the main Gtk struct
getStiffness double getStiffness(): Gets the stiffness of @self.
getStruct void* getStruct(): the main Gtk struct as a void*
ref_ SpringParams ref_(): Increases the reference count of @self.
unref void unref(): Decreases the reference count of @self.

Static functions

getType GType getType()

Variables

adwSpringParams AdwSpringParams* adwSpringParams;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.